Add Swagger files for CLU 2022-03-01-preview #18067

ChongTang · 2022-03-02T19:30:56Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-03-02T19:30:58Z

Hi, @ChongTang Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2022-03-02T19:30:59Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️🔄LintDiff inProgress [Detail]

️❌Avocado: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: cognitiveservices/data-plane/Language/readme.md json: Language/preview/2022-03-01-preview/analyzeconversations.json

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️❌Cross-Version Breaking Changes: 1 Errors, 26 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.9.3)
- current:preview/2022-03-01-preview/analyzeconversations.json compared with base:preview/2021-11-01-preview/analyzeconversations.json
- current:preview/2022-03-01-preview/common.json compared with base:stable/2021-10-01/common.json
- current:preview/2022-03-01-preview/common.json compared with base:preview/2022-02-01-preview/common.json

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'error' that was not found in the old version. New: Language/preview/2022-03-01-preview/common.json#L10:5 Old: Language/stable/2021-10-01/common.json#L10:5

The following breaking changes are detected by comparison with latest preview version:

Rule	Message
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'DeploymentNameQueryParameter' removed or renamed? New: Language/preview/2022-03-01-preview/analyzeconversations.json#L1415:3 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L548:3
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'ProjectNameQueryParameter' removed or renamed? New: Language/preview/2022-03-01-preview/analyzeconversations.json#L1415:3 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L548:3
⚠️ 1009 - RemovedRequiredParameter	The required parameter 'projectName' was removed in the new version. Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L35:9
⚠️ 1009 - RemovedRequiredParameter	The required parameter 'deploymentName' was removed in the new version. Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L35:9
⚠️ 1009 - RemovedRequiredParameter	The required parameter 'ConversationAnalysisOptions' was removed in the new version. Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L35:9
⚠️ 1010 - AddingRequiredParameter	The required parameter 'body' was added in the new version. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L39:11
⚠️ 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L521:9 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L366:9
⚠️ 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L521:9 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L366:9
⚠️ 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L521:9 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L366:9
⚠️ 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L521:9 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L366:9
⚠️ 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L521:9 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L366:9
⚠️ 1026 - TypeChanged	The new version has a different type '' than the previous one 'object'. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L58:13 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L58:13
⚠️ 1030 - DifferentDiscriminator	The new version has a different discriminator than the previous one. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L58:13 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L58:13
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'query' renamed or removed? New: Language/preview/2022-03-01-preview/analyzeconversations.json#L130:7 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L276:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'detectedLanguage' renamed or removed? New: Language/preview/2022-03-01-preview/analyzeconversations.json#L130:7 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L276:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'prediction' renamed or removed? New: Language/preview/2022-03-01-preview/analyzeconversations.json#L130:7 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L276:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'query' renamed or removed? New: Language/preview/2022-03-01-preview/analyzeconversations.json#L256:7 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L90:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'language' renamed or removed? New: Language/preview/2022-03-01-preview/analyzeconversations.json#L256:7 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L90:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'verbose' renamed or removed? New: Language/preview/2022-03-01-preview/analyzeconversations.json#L256:7 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L90:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'listKeys' renamed or removed? New: Language/preview/2022-03-01-preview/analyzeconversations.json#L632:7 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L478:7
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'kind' that was not found in the old version. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L130:7 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L276:7
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'kind' that was not found in the old version. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L58:13 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L58:13
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'conversationItem' that was not found in the old version. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L256:7 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L90:7
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'conversationItem' that was not found in the old version. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L1420:7 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L553:7
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'conversationItem' that was not found in the old version. New: Language/preview/2022-03-01-preview/analyzeconversations.json#L250:5 Old: Language/preview/2021-11-01-preview/analyzeconversations.json#L84:5
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'error' that was not found in the old version. New: Language/preview/2022-03-01-preview/common.json#L10:5 Old: Language/preview/2022-02-01-preview/common.json#L10:5

️🔄SDK Track2 Validation inProgress [Detail]

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2022-03-02T19:30:59Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2022-03-02T19:30:59Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-net warning [Detail]

⚠️Warning [Logs] Generate from e7e52dabbb34a744be9be1fd4bd62eaac4cb37c3. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/cognitiveservices/data-plane/Language/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
warn	No file changes detected after generation
warn	No package detected after generation

️⚠️ azure-sdk-for-python warning [Detail]

⚠️Warning [Logs] Generate from e7e52dabbb34a744be9be1fd4bd62eaac4cb37c3. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh]   ERROR: Command errored out with exit status 1:
cmderr	[automation_init.sh]    command: /home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python -c 'import io, os, sys, setuptools, tokenize; sys.argv[0] = '"'"'/home/vsts/work/1/s/azure-sdk-for-python_tmp/pip-install-7x3s3kyr/markupsafe_8143b9dfb0ee44868439107a46bb2b65/setup.py'"'"'; __file__='"'"'/home/vsts/work/1/s/azure-sdk-for-python_tmp/pip-install-7x3s3kyr/markupsafe_8143b9dfb0ee44868439107a46bb2b65/setup.py'"'"';f = getattr(tokenize, '"'"'open'"'"', open)(__file__) if os.path.exists(__file__) else io.StringIO('"'"'from setuptools import setup; setup()'"'"');code = f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base /home/vsts/work/1/s/azure-sdk-for-python_tmp/pip-pip-egg-info-zcs_atgm
cmderr	[automation_init.sh]        cwd: /home/vsts/work/1/s/azure-sdk-for-python_tmp/pip-install-7x3s3kyr/markupsafe_8143b9dfb0ee44868439107a46bb2b65/
cmderr	[automation_init.sh]   Complete output (30 lines):
cmderr	[automation_init.sh]   Traceback (most recent call last):
cmderr	[automation_init.sh]     File "<string>", line 1, in <module>
cmderr	[automation_init.sh]     File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/pip-install-7x3s3kyr/markupsafe_8143b9dfb0ee44868439107a46bb2b65/setup.py", line 65, in <module>
cmderr	[automation_init.sh]       run_setup(True)
cmderr	[automation_init.sh]     File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/pip-install-7x3s3kyr/markupsafe_8143b9dfb0ee44868439107a46bb2b65/setup.py", line 44, in run_setup
cmderr	[automation_init.sh]       ext_modules=ext_modules if with_binary else [],
cmderr	[automation_init.sh]     File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/lib/python3.6/site-packages/setuptools/__init__.py", line 129, in setup
cmderr	[automation_init.sh]       return distutils.core.setup(**attrs)
cmderr	[automation_init.sh]     File "/usr/lib/python3.6/distutils/core.py", line 121, in setup
cmderr	[automation_init.sh]       dist.parse_config_files()
cmderr	[automation_init.sh]     File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/lib/python3.6/site-packages/setuptools/dist.py", line 494, in parse_config_files
cmderr	[automation_init.sh]       ignore_option_errors=ignore_option_errors)
cmderr	[automation_init.sh]     File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/lib/python3.6/site-packages/setuptools/config.py", line 106, in parse_configuration
cmderr	[automation_init.sh]       meta.parse()
cmderr	[automation_init.sh]     File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/lib/python3.6/site-packages/setuptools/config.py", line 382, in parse
cmderr	[automation_init.sh]       section_parser_method(section_options)
cmderr	[automation_init.sh]     File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/lib/python3.6/site-packages/setuptools/config.py", line 355, in parse_section
cmderr	[automation_init.sh]       self[name] = value
cmderr	[automation_init.sh]     File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/lib/python3.6/site-packages/setuptools/config.py", line 173, in __setitem__
cmderr	[automation_init.sh]       value = parser(value)
cmderr	[automation_init.sh]     File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/lib/python3.6/site-packages/setuptools/config.py", line 430, in _parse_version
cmderr	[automation_init.sh]       version = self._parse_attr(value)
cmderr	[automation_init.sh]     File "/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/lib/python3.6/site-packages/setuptools/config.py", line 305, in _parse_attr
cmderr	[automation_init.sh]       module = import_module(module_name)
cmderr	[automation_init.sh]     File "/usr/lib/python3.6/importlib/__init__.py", line 126, in import_module
cmderr	[automation_init.sh]       return _bootstrap._gcd_import(name[level:], package, level)
cmderr	[automation_init.sh]     File "<frozen importlib._bootstrap>", line 994, in _gcd_import
cmderr	[automation_init.sh]     File "<frozen importlib._bootstrap>", line 971, in _find_and_load
cmderr	[automation_init.sh]     File "<frozen importlib._bootstrap>", line 953, in _find_and_load_unlocked
cmderr	[automation_init.sh]   ModuleNotFoundError: No module named 'markupsafe'
cmderr	[automation_init.sh]   ----------------------------------------
cmderr	[automation_init.sh] WARNING: Discarding https://files.pythonhosted.org/packages/62/0f/52c009332fdadd484e898dc8f2acca0663c1031b3517070fd34ad9c1b64e/MarkupSafe-2.1.0.tar.gz#sha256=80beaf63ddfbc64a0452b841d8036ca0611e049650e20afcb882f5d3c266d65f (from https://pypi.org/simple/markupsafe/) (requires-python:>=3.7). Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] opencensus-ext-azure 1.1.3 requires azure-core<2.0.0,>=1.12.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] azure-identity 1.8.0 requires azure-core<2.0.0,>=1.11.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.3.1 -> 8.5.4
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.4>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.5.4` to update!
cmderr	[automation_generate.sh] npm notice
warn	No file changes detected after generation
warn	No package detected after generation

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2022-03-02T19:32:59Z

Hi @ChongTang, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

ChongTang · 2022-03-03T21:40:56Z

Hi @JeffreyRichter, this PR adds CLU's swagger. We added it on top of the swagger of TA. Both services are under the same /language umbrella. However, there are two validation failures which I hope you can help us.

The Avocado failure says MISSING_APIS_IN_DEFAULT_TAG, which I don't know how to fix because we do not have a default tag. This is also the first time we have tried to put Swagger files of two services under the same version.
The breaking change failure is because we made "error" as required in an error response. Do you know how to override this validation failure?

Thanks for your help.

ChongTang · 2022-03-04T19:52:22Z

The board review issue: #17505

openapi-workflow-bot · 2022-03-07T20:29:07Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

ChongTang · 2022-03-07T21:06:47Z

Hi @tjprescott , this PR has the same [MISSING_APIS_IN_DEFAULT_TAG] failure in Avocado. I tried to add analyzeconversations.json in 2022-02-01-preview but it does not help. I want to add analyzeconversations.json only in 2022-03-01-preview. Really appreciate if you can help me out?

My guess is that because "questionanswering.json" and "questionanswering-authoring.json" are in 2021-07-15-preview, but not in version after that. Is that correct?

But the error message says:
"The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag.
readme: cognitiveservices/data-plane/Language/readme.md
json: Language/preview/2022-03-01-preview/analyzeconversations.json"

Looks like it's about analyzeconversations.json, so I am confused. Any help would be appreciated.

ChongTang · 2022-03-08T21:07:43Z

Hi @weidongxu-microsoft or @tjprescott . This PR has the same MISSING_APIS_IN_DEFAULT_TAG issue. This PR merges CLU's 2022-03-01-preview version into a release/feature branch. Can you help us skip this check? Thanks!

weidongxu-microsoft · 2022-03-09T00:58:56Z

@ChongTang skip CI (due to false positive) will only happen before you are ready to merge. I don't think this PR is at this stage yet.

tjprescott · 2022-03-09T18:13:42Z

/azp run

azure-pipelines · 2022-03-09T18:13:52Z

Azure Pipelines successfully started running 1 pipeline(s).

heaths

My only concern blocking the PR is about some of the modelAsString: false declarations. You should only specify false if the model will only ever be input, or if you're 100% certain the discriminator will never change. Is that true for all instances of false? Happy to flip to approve if so, though I had a few small nits as well but don't need to block the PR for those.

specification/cognitiveservices/data-plane/Language/readme.md

...n/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json

heaths

There's a couple that seem like they should be true. Could you double check the following four, though?

These seem like they should be true. The discriminators - especially the first - seem like something that could easily change over time:

BaseResolution.resolutionKind
NumericRangeResolution.rangeKind

These very well could be immutable and never change, but might be good to double check assumptions:

DateTimeResolution.dateTimeSubKind
NumberResolution.numberKind

Apart from that, the changes look good.

heaths

Actually, there's 4 more instances of "language" (or "detectedLanguage") that you might want to document are BCP 47, if, in fact, they are:

azure-rest-api-specs/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json

Line 394 in a74a789

"language": {
azure-rest-api-specs/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json

Line 436 in 67e66fc

"detectedLanguage": {
azure-rest-api-specs/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json

Line 561 in a74a789

"description": "The detected language from the query.",

ChongTang · 2022-03-15T23:37:10Z

Actually, there's 4 more instances of "language" (or "detectedLanguage") that you might want to document are BCP 47, if, in fact, they are:

azure-rest-api-specs/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json

Line 394 in a74a789

"language": {

azure-rest-api-specs/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json

Line 436 in 67e66fc

"detectedLanguage": {

azure-rest-api-specs/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json

Line 561 in a74a789

"description": "The detected language from the query.",

Thanks Heath! I resolve both "language" and "modelAsString" issues. I also searched in the file and resolved all occurrences.

* Add Swagger files for CLU 2022-03-01-preview * Fix prettier errors * Fix sub id description * Try to fix the missing API error * Try to resolve the error of missing APIs in the default tag * Remove 2022-02-01 CLU files * Resolve comments * Resolve comments * Resolve more comments Co-authored-by: Chong Tang <chot@microsoft.com>

Add Swagger files for CLU 2022-03-01-preview

5b96713

ChongTang requested a review from yangyuan as a code owner March 2, 2022 19:30

openapi-assignment-bot bot assigned tjprescott Mar 2, 2022

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Mar 2, 2022

Chong Tang added 2 commits March 2, 2022 15:43

Fix prettier errors

61bc1a3

Fix sub id description

a0b052a

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 3, 2022

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 4, 2022

ChongTang mentioned this pull request Mar 4, 2022

[Language Service - Conversational Language Understanding] REST API Review of new Preview version 2022-03-01-preview #17505

Closed

Try to fix the missing API error

400ff8e

openapi-pipeline-app bot added the NewApiVersionRequired label Mar 7, 2022

Try to resolve the error of missing APIs in the default tag

8249334

Remove 2022-02-01 CLU files

3ccffaf

openapi-pipeline-app bot removed the NewApiVersionRequired label Mar 8, 2022

ChongTang mentioned this pull request Mar 8, 2022

Release/cognitiveservices/clu 2021 11 01 preview #17507

Merged

25 tasks

tjprescott added the Approved-Avocado label Mar 9, 2022

heaths self-requested a review March 9, 2022 18:17

heaths requested changes Mar 10, 2022

View reviewed changes

Resolve comments

a74a789

heaths reviewed Mar 11, 2022

View reviewed changes

...n/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/analyzeconversations.json Show resolved Hide resolved

Resolve comments

67e66fc

heaths requested changes Mar 11, 2022

View reviewed changes

Resolve more comments

84e3c74

heaths approved these changes Mar 16, 2022

View reviewed changes

heaths merged commit 8d186bf into Azure:dev-cognitiveservices-Language-2022-03-01-preview Mar 16, 2022

heaths mentioned this pull request Apr 7, 2022

Set codeowners for Cognitive Lanugage swaggers #18602

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Swagger files for CLU 2022-03-01-preview #18067

Add Swagger files for CLU 2022-03-01-preview #18067

ChongTang commented Mar 2, 2022

openapi-workflow-bot bot commented Mar 2, 2022

openapi-pipeline-app bot commented Mar 2, 2022 •

edited

Loading

openapi-workflow-bot bot commented Mar 2, 2022

openapi-pipeline-app bot commented Mar 2, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Mar 2, 2022

ChongTang commented Mar 3, 2022

ChongTang commented Mar 4, 2022

openapi-workflow-bot bot commented Mar 7, 2022

ChongTang commented Mar 7, 2022 •

edited

Loading

ChongTang commented Mar 8, 2022

weidongxu-microsoft commented Mar 9, 2022 •

edited

Loading

tjprescott commented Mar 9, 2022

azure-pipelines bot commented Mar 9, 2022

heaths left a comment

heaths left a comment

heaths left a comment

ChongTang commented Mar 15, 2022

Add Swagger files for CLU 2022-03-01-preview #18067

Add Swagger files for CLU 2022-03-01-preview #18067

Conversation

ChongTang commented Mar 2, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Mar 2, 2022

openapi-pipeline-app bot commented Mar 2, 2022 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Mar 2, 2022

openapi-pipeline-app bot commented Mar 2, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Mar 2, 2022

ChongTang commented Mar 3, 2022

ChongTang commented Mar 4, 2022

openapi-workflow-bot bot commented Mar 7, 2022

ChongTang commented Mar 7, 2022 • edited Loading

ChongTang commented Mar 8, 2022

weidongxu-microsoft commented Mar 9, 2022 • edited Loading

tjprescott commented Mar 9, 2022

azure-pipelines bot commented Mar 9, 2022

heaths left a comment

Choose a reason for hiding this comment

heaths left a comment

Choose a reason for hiding this comment

heaths left a comment

Choose a reason for hiding this comment

ChongTang commented Mar 15, 2022

openapi-pipeline-app bot commented Mar 2, 2022 •

edited

Loading

openapi-pipeline-app bot commented Mar 2, 2022 •

edited

Loading

ChongTang commented Mar 7, 2022 •

edited

Loading

weidongxu-microsoft commented Mar 9, 2022 •

edited

Loading